Детальная информация о сотруднике

Запрос позволяет получить подробную информацию о сотруднике клиента.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/users?user_id={идентификатор сотрудника}

Заголовки запроса

Authorization: Bearer <OAuth-токен>
Процесс получения токена описан в разделе Начало работы.

X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

user_id — идентификатор сотрудника, по которому предоставляется информация.

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле	Описание	Формат
`fullname`	Полное имя сотрудника.	Строка
`is_active`	Признак активности сотрудника. Неактивный сотрудник не имеет возможности самостоятельного заказа и на его имя нельзя заказать поездку.	Логическое
`phone`	Телефонный номер сотрудника.	Строка
`id`	Идентификатор сотрудника.	Строка
`is_deleted`	Признак архивированного сотрудника.	Логическое
`cost_center`	Название центра затрат клиента.	Строка
`cost_centers_id`	Идентификатор набора настроек центров затрат при наличии у клиента новых центров затрат. Необязательное поле.	Строка
`department_id`	Идентификатор департамента в личном кабинете.	Строка
`limits`	Ограничения на сумму, которую сотрудник может потратить на определенный сервис за календарный месяц.	Массив элементов, содержит отдельный элемент для каждого сервиса.
`nickname`	Краткое имя сотрудника. В интерфейсе личного кабинета является полем ID во внешней системе.	Строка
`email`	Адрес электронной почты сотрудника.	Строка
`client_id`	Идентификатор клиента.	Строка

Структура элемента массива limits:

Поле

Описание

Формат

limit_id

Идентификатор ранее созданного лимита, который будет назначен пользователю.

Строка

service

Название сервиса. Возможные значения:

taxi: Яндекс Go;
eats2: Яндекс Еда и Яндекс Лавка;
grocery: Яндекс Лавка;
drive: Каршеринг;
tanker: Яндекс Заправки;
cargo: Грузоперевозки;
travel: Яндекс Путешествия;
scooters: Яндекс Самокаты.

Строка

Пример запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/users?user_id=f65...c57d
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
  "fullname": "Иванов Илья",
  "is_active": true,
  "phone": "+79262770203",
  "id": "2e….b6",
  "is_deleted": false,
  "cost_center": "",
  "cost_centers_id": "2c53…1",
  "department_id": "b617…4",
  "limits": [
     {
       "limit_id": "d4c...8",
       "service": "taxi"
     },
     {
       "limit_id": "473…8",
       "service": "eats2"
     },
     {
       "limit_id": "df…f",
       "service": "cargo"
     }
     ],
  "nickname": "",
  "client_id": "bee…c"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

200 — запрос выполнен успешно.
401 — был передан неверный OAuth-токен.
403 — у клиента не хватает прав на выполнение данного запроса:
- SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
- SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
404 — запрашиваемая запись не найдена.

Была ли статья полезна?

Архивирование сотрудника

Получение детальной информации по номеру телефона